Class EnvironmentKeyframeImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.EnvironmentKeyframeImpl
All Implemented Interfaces:
IPCObject, EnvironmentKeyframe

public class EnvironmentKeyframeImpl extends IPCObjectImpl implements EnvironmentKeyframe
Information provided by the PKI file:

    \class EnvironmentKeyframe
    
    \brief An object in the Physical Workspace.
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getTime

      public int getTime()
      Information provided by the PKI file:
      
          \brief Returns the time the keyframe is set to exist at, in seconds.
          
          \return int, value is the time the keyframe resides at, in seconds.
          
              
      Specified by:
      getTime in interface EnvironmentKeyframe
      Returns:
      int Returns a int
    • setTime

      public void setTime(int time)
      Information provided by the PKI file:
      
          \brief Sets the time the keyframe exists at, in seconds.
          
          \param time, value is the time the keyframe resides at, in seconds.
          
              
      Specified by:
      setTime in interface EnvironmentKeyframe
      Parameters:
      time - Takes in a parameter of time
    • getEnvironmentOptionsCount

      public int getEnvironmentOptionsCount()
      Information provided by the PKI file:
      
          \brief Returns how many different environment value properties ("CO", "Sunlight", etc) are in the key frame.
          
          \return int, value is how many different environment value properties ("CO", "Sunlight", etc) are in the key frame.
          
              
      Specified by:
      getEnvironmentOptionsCount in interface EnvironmentKeyframe
      Returns:
      int Returns a int
    • getEnvironmentKeys

      public List<String> getEnvironmentKeys()
      Information provided by the PKI file:
      
          \brief Returns the names of all the environment value properties ("CO", "Sunlight", etc) are in the key frame.
          
          \return vector<QString>, a list with an entry for each environment property name in the keyframe.
          
              
      Specified by:
      getEnvironmentKeys in interface EnvironmentKeyframe
      Returns:
      List<String> Returns a List<String>
    • getEnvironment

      public EnvironmentOptions getEnvironment(String env)
      Information provided by the PKI file:
      
          \brief Returns the environment properties for the environment value property type passed.
          
          \param env, Name of the environment property type to get the properties for.  Like "CO", "Sunlight", etc.
          
          \return EnvironmentOptions, the enivronment options for the given environment value type.
          
              
      Specified by:
      getEnvironment in interface EnvironmentKeyframe
      Parameters:
      env - Takes in a parameter of env
      Returns:
      EnvironmentOptions Returns a EnvironmentOptions